Events
Below is a list of events that are published and their available fields.
Tool Connection Events
This event is generated every time a tool is attempted to be connected to QuickLink.
| Name | Type | Comment |
|---|---|---|
| source | string | Source of the event (Eg: 'Quicklink Prod') |
| tool_mpbid | string | Unique identifier programmed into a tool (Eg: '0034000064') |
| ble_mpbid | string | Unique identifier programmed into BLE (Eg: '00A1184070') |
| adapter_mpbid | string | Unique identifier programmed into an adapter (Eg. '0034000064') |
| tool_product_id | string | Tool product id. Value is first 4 characters of tool_mpbid. (Eg. '0034') |
| adapter_product_id | string | Adapter product id. Value is first 4 characters of adapter_mpbid. (Eg. '0034') |
| tool_firmware | string | Tool firmware version |
| ble_firmware | string | Bluetooth firmware version |
| adapter_firmware | string | Adapter firmware version |
| connection_type | string | One of 'CommunicationAdapter', 'BLE112Dongle', 'IntegratedBLE', 'DongleMode', 'BleuIO', 'FTDI', 'Raw', 'WebSocket' |
| connection_start_time | timestamp | Timestamp of the connection attempt |
| timestamp | timestamp | Timestamp of the event |
| status | string | 'success' or 'failure' of the connection attempt |
| error | string | Error message from the connection attempt |
| user | string | User email (Eg. 'trcbbcvql@milwaukeetool.onmicrosoft.com') |
| user_mode | bigint | This is the mode that quick link is operating under when the event occurred. Possible values: OrderEntry = 1, Technician = 2, Engineer = 3, ManufacturingAuditor = 4, ManufacturingLineOperator = 5,ToolID = 7,Rework = 11, RGA = 12 |
| user_locality | string | User's location (Eg. 'Madison_WI_53707') |
| communication_interface | string | One of 'Bluetooth', 'Serial', 'CAN', 'FTDI' |
| tool_session | string | Tool session ID that is generated when a tool is connected to QuickLink. Can be used to correlate events from the same tool connection. |
Tool Data Events
This event is generated every time data is downloaded from a tool and uploaded to the cloud.
| Name | Type | Comment |
|---|---|---|
| source | string | Source of the event (Eg: 'Quicklink Prod') |
| tool_mpbid | string | Unique identifier programmed into a tool (Eg: '0034000064') |
| tool_product_id | string | Tool product id. Value is first 4 characters of tool_mpbid. (Eg. '0034') |
| data_logger_type | string | Type of data logger. One of HydraulicGen1, HydraulicGen2, HydraulicGen4, ADL, DTW, or MemoryMap |
| data_logger_sub_type | string | Subtype of data logger. One of RealTime, Sequential, or BulkRealTime |
| download_start_time | timestamp | Timestamp of the download start |
| download_complete_time | timestamp | Timestamp of the download completion |
| download_status | string | Status of the download (Eg: 'success') |
| download_parameters | string | Parameters of the download request in JSON format |
| download_error | string | Error message if the download failed |
| upload_status | string | Status of the upload (Eg: 'success') |
| upload_error | string | Error message if the upload failed (Ex in raw: 'uploadError':'Error message') |
| timestamp | timestamp | Timestamp of the event |
| user | string | User email (Eg: 'trcbbcvql@milwaukeetool.onmicrosoft.com') |
| user_mode | bigint | This is the mode that quick link is operating under when the event occurred. Possible values: OrderEntry = 1, Technician = 2, Engineer = 3, ManufacturingAuditor = 4, ManufacturingLineOperator = 5, ToolID = 7, Rework = 11, RGA = 12 |
| user_locality | string | User's location (Eg. 'Madison_WI_53707') |
| tool_session | string | Tool session ID that is generated when a tool is connected to QuickLink. Can be used to correlate events from the same tool connection. |
Tool Fault Events
This event is generated every time there is a failure communicating with a tool, that was not an initial connection issue.
| Name | Type | Comment |
|---|---|---|
| source | string | Source of the event (Eg: 'Quicklink Prod') |
| fault_source | string | Source of the fault. Possible values: dongle, adapter, tool, ble, client, server, unknown |
| fault_time | timestamp | Timestamp of the fault (Eg: '2024-07-09 17:28:25.793000') |
| fault_type | string | Type of the fault. Possible values: NAK, disconnect, client |
| fault_message | string | Message of the fault (Eg: 'Received NAK Response. Command: 00 09 04, Response: 83 58 02 10 02 00 EF') |
| timestamp | timestamp | Timestamp of the event |
| user | string | User email (Eg: 'trcbbcvql@milwaukeetool.onmicrosoft.com') |
| user_mode | bigint | This is the mode that quick link is operating under when the event occurred. Possible values: OrderEntry = 1, Technician = 2, Engineer = 3, ManufacturingAuditor = 4, ManufacturingLineOperator = 5, ToolID = 7, Rework = 11, RGA = 12 |
| tool_session | string | Tool session ID that is generated when a tool is connected to QuickLink. Can be used to correlate events from the same tool connection. |
| user_locality | string | User's location (Eg. 'Madison_WI_53707') |
Tool Electronic Initialization Events
This event is generated when a tool is electronically initialized through QuickLink.
| Name | Type | Comment |
|---|---|---|
| source | string | Source of the event (Ex: 'Quicklink Web') |
| platform | string | Platform of the tool (Ex: 'M18') |
| serial_number | string | Comprised of tool, facility, date, and unit information (Ex: 'H53AD171600112') |
| mpbid | string | Unique identifier programmed into a tool (For tools supporting OpenLink protocol, Ex: '0034000064'. For tools not supporting OpenLink protocol, Ex: 'FFFFAAABBBCCCDDD01234') |
| product_id | string | Value is first 4 characters of mpbid (Ex: '0034') |
| adapter_firmware_revision | string | Adapter firmware revision (Ex: '6.1.0.6') |
| timestamp | timestamp | Timestamp of the event (Ex: '2024-07-09 17:28:25.793000') |
| status | string | Status of the initialization (Ex: 'Success') |
| user | string | User email (Ex: 'trcbbcvql@milwaukeetool.onmicrosoft.com') |
| user_mode | bigint | This is the mode that quick link is operating under when the event occurred (Ex: 2) |
| user_locality | string | User's location (Eg. 'Madison_WI_53707') |
| tool_session | string | Tool session ID that is generated when a tool is connected to QuickLink. Can be used to correlate events from the same tool connection. |
Manufacturing Programming Events
This event is generated when the Manufacturing End of Line programming completes for a tool.
| Name | Type | Comment |
|---|---|---|
| source | string | Source of the event (Eg. 'Quicklink Web') |
| script_status | string | Status of the script (Eg. 'SUCCEEDED') |
| allocated_tool_mpbid | string | Unique identifier programmed into a tool |
| allocated_ble_mpbid | string | Unique identifier programmed into a BLE |
| serial_number | string | Serial Number of the tool. Comprised of tool, facility, date, and unit information (Ex: 'H53AD171600112') |
| client_version | string | Version of client (Eg. '0') |
| failure_state | string | State of the failure (Eg. 'Write Default METCO Password to Enable Mailbox'). |
| failure_message | string | Error message |
| product_id | string | Value is first 4 characters of mpbid (Eg. '0034') |
| operator_account | string | User email (Ex: 'trcbbcvql@milwaukeetool.onmicrosoft.com') |
| user_mode | bigint | This is the mode that quick link is operating under when the event occurred (Eg. 5 = ManufacturingLineOperator) |
| facility | string | Facility (Eg. 'H') |
| line | string | Manufacturing Line (Eg: 'MXF600') |
| timestamp | timestamp | Timestamp of the event (Eg. '2024-08-09 14:57:01.319000') |
PCBA Forcelogic Diagnostic Events
This event is generated every time a PCBA Forcelogic diagnostic is performed.
| Name | Type | Comment |
|---|---|---|
| source | string | Source of the event (Ex: 'Quicklink Web') |
| mpbid | string | Mpbid of the tool. |
| product_id | string | Product ID of the tool. |
| sv_code | string | |
| created_on | timestamp | |
| status | string | Status of the diagnostic (Ex: 'Success') |
| error_message | string | Error message as error_message. |
| calculated_symptom_code | string | |
| calculated_da_code | string | |
| calculated_eng_pcba_codes | string[] | Must be a list of strings. |
| user | string | User email (Ex: 'trcbbcvql@milwaukeetool.onmicrosoft.com') |
| user_mode | bigint | This is the mode that quick link is operating under when the event occurred (Ex: 2) |
| script_name | string | MTSL Script ran to generate the diagnostic event. |
| script_version | string | MTSL Script Version ran to generate the diagnostic event. |